home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / sndoff15.zip / SOUNDOFF.DOC < prev    next >
Text File  |  1992-08-18  |  14KB  |  351 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                  SOUND OFF!
  11.  
  12.                                 Version 1.5
  13.  
  14.                         Command Line and Batch File
  15.                                Sound Producer
  16.  
  17.  
  18.                        (C) Copyright 1992 Rand Nowell
  19.                              RaLin Enterprises
  20.                         "Putting Bits Together" (tm)
  21.  
  22.  
  23.                                   Copyright:                      i
  24.  
  25.    Sound Off!, the program and documentation,
  26.    is not a Public Domain or Free program. It is the
  27.    Copyrighted (C)1992 work of Rand Nowell dba Ralin Enterprises.
  28.    All rights are reserved. Copying, duplicating, selling or otherwise
  29.    distributing this product except as noted in the Distribution Policy
  30.    below is a violation of Federal Copyright Law.
  31.  
  32.  
  33.    Distribution:
  34.  
  35.    1. Feel free to distribute the Shareware version of this program as
  36.       often as you like to any interested parties. Distribution to
  37.       Electronic Bullentin Boards is encouraged.
  38.    2. Please do not distribute this program without all the original
  39.       related files such as documentation, readme files, registration
  40.       forms etc.
  41.    3. Please distribute ONLY the original authenticated ZIP format file.
  42.    4. Please obtain our written permission before including the program
  43.       with any "bundled" software packages.
  44.    5. Please do not accept payment for the program; a copying fee of
  45.       $5.00 per diskette may be charged by a non-profit user-group.
  46.    6. Please do not alter the program or documentation in any way.
  47.    7. Individuals, groups, vendors or other software distribution
  48.       companies which market diskettes containg shareware or test-drive
  49.       evaluation programs, for profit, must obtain written permission
  50.       from RaLin Enterprises prior to distribution.
  51.  
  52.     PLEASE SEE THE DISTRIBUTION NOTE LATER IN THE MANUAL FOR DISTRIBUTION
  53.     POLICY FOR THIS PROGRAM. IT OVER-RIDES CERTAIN PARTS OF THIS
  54.     COPYRIGHT NOTICE.
  55.  
  56.     ************************* DISCLAIMER *****************************
  57.  
  58.     This program is supplied "as is" without warrenty of any kind. The
  59.     entire risk of using, and results from the use of, is assumed by you
  60.     the user.  You assume all costs of repair, servicing and corrections
  61.     stemming from the use of this program.
  62.     Rand Nowell and/or RaLin Enterprises, or any other associated
  63.     company of the program author will not be held liable for any
  64.     damages from the use of this program. No warrenties are expressed or
  65.     implied.
  66.     ********************************************************************
  67.     To the original licensee of the REGISTERD version of The Program
  68.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  69.     program is recorded, be free from defects in material and
  70.     workmanship under normal use and service for a period of (90) ninety
  71.     days from date of delivery as evidenced by your receipt. Our entire
  72.     liability and your exclusive remedy shall be replacement of the
  73.     deffective disk not meeting the standards of this limited warranty.
  74.     And in no case shall exceed the cost of reimbursment of monies paid for
  75.     program registration.
  76.  
  77.  
  78. Sound Off!          Batch/Command Line Sound Generator 1.5          Page   1
  79.  
  80. OVERVIEW:
  81.  
  82.    Sound Off! can be used to generate sound patterns from the command line or
  83.    from within a batch file. Frequencies can be given on the command line or
  84.    read from a Script File.
  85.  
  86.    Various switches are provided for Turning off display messages, Running
  87.    an "Alarm", Turning off a "runaway" sound, Reading from script file.
  88.  
  89. SYSTEM REQUIREMENTS:
  90.  
  91.     Are few.  IBM PC/XT or better, running Dos 3x and up.
  92.               Video: Runs on mono or color.
  93.               Disks: Will run on floppy system, but performance is slow
  94.                      for scripts.
  95.  
  96.  
  97. COMMAND SYNTAX:
  98.  
  99. SOUNDOFF [switches][scriptfile]<Start_Frequency><End_Frequency><Delay><Step>
  100.  
  101.     See examples for variables for Alarm Procedures.
  102.  
  103.     Examples will be provided shortly. For now lets explore these options
  104.     and parameters.
  105.  
  106.     The minimum needed for Sound Off! to work are the frequencies, the delay
  107.     factor, and the step factor.
  108.  
  109.     Frequencies will hereafter be reffered to as "notes".
  110.  
  111.      * Start_Freq: This is the first note to be played, anything below about
  112.        70 probably won't be heard unless you have a special speaker setup
  113.        for your PC.
  114.  
  115.      * End_Freq: This is the last note Sound Off! will play. After about
  116.        2500, the note again becomes hard to hear.
  117.  
  118.      * Delay: This is the time, in milliseconds, for Sound Off! to pause
  119.        between the playing of each note. There are aprox. 1000 milliseconds
  120.        to a second. I say aprox., because the PC timer is not as accurate as
  121.        a watch. If you specify 1000 for a delay, the delay will not likely
  122.        be an exact second.
  123.  
  124.      * Step: This specifies how big a jump Sound Off! should make between
  125.        notes. For instance, Start and End of 200 & 900 with a Step value of
  126.        50 will play the notes 200 250 300 350 400 450 500 550 600 650...900
  127.  
  128.     Experimentation with these values is the best teacher!
  129.  
  130.        To play a "tune" UP the scale make the Start_Frequency LESS
  131.        than the End_Frequency.
  132.  
  133.        Reverse this to play DOWN the scale, The Start_Frequency should
  134.  
  135.   Bring life to your Batch Files with Sound!!
  136.  
  137.  
  138. Sound Off!          Batch/Command Line Sound Generator 1.5          Page  2
  139.  
  140.        be GREATER than the End_Frequency.
  141.  
  142.  
  143. SWITCHES:
  144.  
  145.      Switches may be upper or lower case. They must be proceeded by a
  146.      forward slash, ie: /f  and they must be seperated by a space, from any
  147.      other variable. Only one switch at a time is used. There are no
  148.      instances where more than one switch can be used.
  149.  
  150.   /f Instructs Sound Off! to read variables from a scriptfile. The syntax is
  151.      SOUNDOFF /f filename. Program displays are active.
  152.      The script file is a simple Ascii text file and can be created by
  153.      any Ascii text file editor. You should give the scriptfile the extension
  154.      of .SOS This extension is REQUIRED!
  155.  /fs Runs the script file with Displays turned off.
  156.      SOUNDOFF /fs filename
  157.  
  158.      Our program TFREQ (Ver 2.0) will create script files for Sound Off!
  159.  
  160.      When you specify the filename on the command line, do not included the
  161.      extension, it is assigned by Sound Off!  If the script file resides in a
  162.      directory that is included in your PATH statement, or in the current
  163.      directory then only the filename is needed.
  164.      If it does not then include a drive\dir\ with the filename.
  165.  
  166.      The script file must not include any alpha characters in the variable
  167.      lines. All variables must be numeric: from 0..9  Values must start in
  168.      the first column, and must have a space between them.
  169.      You can view the sample scripts included, but a small example is given
  170.      here.
  171.  
  172.      While running a script, Sound Off! does not display any messages or
  173.      screen antics. It runs in silent mode. (See /s switch)
  174.  
  175.      Scripts use only one frequency and one delay per note, no End_Freq or
  176.      Step is used.
  177.  
  178.              Example Script:     400 50
  179.                                  640 10
  180.                                  330 25
  181.                                  440 50
  182.                                  550 200
  183.  
  184.       COMMENTS IN SCRIPTS:
  185.  
  186.       If you wish to add comments to the script, put a 0 (ZERO) for the
  187.       last frequency and delay, then insert comments after that. ie:
  188.  
  189.           400 50
  190.           .
  191.           .
  192.           .
  193.           550 200
  194.  
  195.   Bring life to your Batch Files with Sound!!
  196.  
  197.  
  198. Sound Off!          Batch/Command Line Sound Generator 1.5          Page  3
  199.  
  200.           0 0
  201.           Note: This is a test script for John.
  202.           eof filename.sos
  203.  
  204.        If you are careful, you can place comments to the right of the notes
  205.        and delays. Be sure to move to the right at least 3 or 4 spaces.
  206.  
  207.        You can write a letter after the var